<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Counter APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__counter__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Counter APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4d812ffb5d2d1f54b8fd94bc5d8596d5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">xTraceCounterAdd</a>(xCounterHandle,  xValue)&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#gaab9ced4239f659fbe9390187e05cbd4a">xTraceCounterSet</a>(xCounterHandle, (TraceBaseType_t)(xTraceEntryGetStateReturn((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX)) + (xValue))</td></tr>
<tr class="memdesc:ga4d812ffb5d2d1f54b8fd94bc5d8596d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds value to trace counter.  <br /></td></tr>
<tr class="separator:ga4d812ffb5d2d1f54b8fd94bc5d8596d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ac6b92f37a58f899fab057331c25f39"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga0ac6b92f37a58f899fab057331c25f39">xTraceCounterGet</a>(xCounterHandle,  pxValue)&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td></tr>
<tr class="memdesc:ga0ac6b92f37a58f899fab057331c25f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace counter value.  <br /></td></tr>
<tr class="separator:ga0ac6b92f37a58f899fab057331c25f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6374de3cf1de24d354ea095c75a54742"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga6374de3cf1de24d354ea095c75a54742">xTraceCounterIncrease</a>(xCounterHandle)&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">xTraceCounterAdd</a>(xCounterHandle, 1)</td></tr>
<tr class="memdesc:ga6374de3cf1de24d354ea095c75a54742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases trace counter value.  <br /></td></tr>
<tr class="separator:ga6374de3cf1de24d354ea095c75a54742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9d39eb5516a05710a2db79cc7dcc181"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#gaa9d39eb5516a05710a2db79cc7dcc181">xTraceCounterDecrease</a>(xCounterHandle)&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">xTraceCounterAdd</a>(xCounterHandle, -1)</td></tr>
<tr class="memdesc:gaa9d39eb5516a05710a2db79cc7dcc181"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases trace counter value.  <br /></td></tr>
<tr class="separator:gaa9d39eb5516a05710a2db79cc7dcc181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga692a007ff950ec87f1988782ca1145c0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga692a007ff950ec87f1988782ca1145c0">xTraceCounterGetUpperLimit</a>(xCounterHandle,  pxValue)&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_UPPER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td></tr>
<tr class="memdesc:ga692a007ff950ec87f1988782ca1145c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace counter upper limit.  <br /></td></tr>
<tr class="separator:ga692a007ff950ec87f1988782ca1145c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba3f1e8fc86f08abb8451d7cb4503c76"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#gaba3f1e8fc86f08abb8451d7cb4503c76">xTraceCounterGetLowerLimit</a>(xCounterHandle,  pxValue)&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_LOWER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td></tr>
<tr class="memdesc:gaba3f1e8fc86f08abb8451d7cb4503c76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace counter lower limit.  <br /></td></tr>
<tr class="separator:gaba3f1e8fc86f08abb8451d7cb4503c76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab04248a0d3ad6abe5e9a787b26091524"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#gab04248a0d3ad6abe5e9a787b26091524">xTraceCounterGetName</a>(xCounterHandle,  pszName)&#160;&#160;&#160;xTraceEntryGetSymbol((TraceEntryHandle_t)(xCounterHandle), pszName)</td></tr>
<tr class="memdesc:gab04248a0d3ad6abe5e9a787b26091524"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace counter name.  <br /></td></tr>
<tr class="separator:gab04248a0d3ad6abe5e9a787b26091524"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4feede3ee8b5b78ec2ec8ac534b9ef7e"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga4feede3ee8b5b78ec2ec8ac534b9ef7e">xTraceCounterInitialize</a> (TraceCounterData_t *pxBuffer)</td></tr>
<tr class="memdesc:ga4feede3ee8b5b78ec2ec8ac534b9ef7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Counter trace system.  <br /></td></tr>
<tr class="separator:ga4feede3ee8b5b78ec2ec8ac534b9ef7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e9567e1b12afeea68e415f46963c5ca"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#ga2e9567e1b12afeea68e415f46963c5ca">xTraceCounterSetCallback</a> (TraceCounterCallback_t xCallback)</td></tr>
<tr class="memdesc:ga2e9567e1b12afeea68e415f46963c5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace counter callback.  <br /></td></tr>
<tr class="separator:ga2e9567e1b12afeea68e415f46963c5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc5ffcf7218f9b9dfde860aa3f0f2632"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#gabc5ffcf7218f9b9dfde860aa3f0f2632">xTraceCounterCreate</a> (const char *szName, TraceBaseType_t xInitialValue, TraceBaseType_t xLowerLimit, TraceBaseType_t xUpperLimit, TraceCounterHandle_t *pxCounterHandle)</td></tr>
<tr class="memdesc:gabc5ffcf7218f9b9dfde860aa3f0f2632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates trace counter.  <br /></td></tr>
<tr class="separator:gabc5ffcf7218f9b9dfde860aa3f0f2632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab9ced4239f659fbe9390187e05cbd4a"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__counter__apis.html#gaab9ced4239f659fbe9390187e05cbd4a">xTraceCounterSet</a> (TraceCounterHandle_t xCounterHandle, TraceBaseType_t xValue)</td></tr>
<tr class="memdesc:gaab9ced4239f659fbe9390187e05cbd4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace counter value.  <br /></td></tr>
<tr class="separator:gaab9ced4239f659fbe9390187e05cbd4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga4d812ffb5d2d1f54b8fd94bc5d8596d5" name="ga4d812ffb5d2d1f54b8fd94bc5d8596d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">&#9670;&#160;</a></span>xTraceCounterAdd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterAdd</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#gaab9ced4239f659fbe9390187e05cbd4a">xTraceCounterSet</a>(xCounterHandle, (TraceBaseType_t)(xTraceEntryGetStateReturn((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX)) + (xValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds value to trace counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa9d39eb5516a05710a2db79cc7dcc181" name="gaa9d39eb5516a05710a2db79cc7dcc181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa9d39eb5516a05710a2db79cc7dcc181">&#9670;&#160;</a></span>xTraceCounterDecrease</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterDecrease</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">xTraceCounterAdd</a>(xCounterHandle, -1)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decreases trace counter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0ac6b92f37a58f899fab057331c25f39" name="ga0ac6b92f37a58f899fab057331c25f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ac6b92f37a58f899fab057331c25f39">&#9670;&#160;</a></span>xTraceCounterGet</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterGet</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_VALUE_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace counter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxValue</td><td>Returned value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaba3f1e8fc86f08abb8451d7cb4503c76" name="gaba3f1e8fc86f08abb8451d7cb4503c76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba3f1e8fc86f08abb8451d7cb4503c76">&#9670;&#160;</a></span>xTraceCounterGetLowerLimit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterGetLowerLimit</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_LOWER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace counter lower limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxValue</td><td>Returned value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab04248a0d3ad6abe5e9a787b26091524" name="gab04248a0d3ad6abe5e9a787b26091524"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab04248a0d3ad6abe5e9a787b26091524">&#9670;&#160;</a></span>xTraceCounterGetName</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterGetName</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pszName&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetSymbol((TraceEntryHandle_t)(xCounterHandle), pszName)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace counter name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pszName</td><td>Returned name.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga692a007ff950ec87f1988782ca1145c0" name="ga692a007ff950ec87f1988782ca1145c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga692a007ff950ec87f1988782ca1145c0">&#9670;&#160;</a></span>xTraceCounterGetUpperLimit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterGetUpperLimit</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState((TraceEntryHandle_t)(xCounterHandle), TRC_COUNTER_UPPER_LIMIT_INDEX, (TraceUnsignedBaseType_t*)(pxValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace counter upper limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxValue</td><td>Returned value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6374de3cf1de24d354ea095c75a54742" name="ga6374de3cf1de24d354ea095c75a54742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6374de3cf1de24d354ea095c75a54742">&#9670;&#160;</a></span>xTraceCounterIncrease</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceCounterIncrease</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xCounterHandle</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__trace__counter__apis.html#ga4d812ffb5d2d1f54b8fd94bc5d8596d5">xTraceCounterAdd</a>(xCounterHandle, 1)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Increases trace counter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabc5ffcf7218f9b9dfde860aa3f0f2632" name="gabc5ffcf7218f9b9dfde860aa3f0f2632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc5ffcf7218f9b9dfde860aa3f0f2632">&#9670;&#160;</a></span>xTraceCounterCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceCounterCreate </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xInitialValue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xLowerLimit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xUpperLimit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceCounterHandle_t *&#160;</td>
          <td class="paramname"><em>pxCounterHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates trace counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xInitialValue</td><td>Initial value. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xLowerLimit</td><td>Lower limit. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xUpperLimit</td><td>Upper limit. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxCounterHandle</td><td>Uninitialized trace counter handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga4feede3ee8b5b78ec2ec8ac534b9ef7e" name="ga4feede3ee8b5b78ec2ec8ac534b9ef7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4feede3ee8b5b78ec2ec8ac534b9ef7e">&#9670;&#160;</a></span>xTraceCounterInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceCounterInitialize </td>
          <td>(</td>
          <td class="paramtype">TraceCounterData_t *&#160;</td>
          <td class="paramname"><em>pxBuffer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the Counter trace system. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxBuffer</td><td>Pointer to memory that is used by the counter system</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaab9ced4239f659fbe9390187e05cbd4a" name="gaab9ced4239f659fbe9390187e05cbd4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaab9ced4239f659fbe9390187e05cbd4a">&#9670;&#160;</a></span>xTraceCounterSet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceCounterSet </td>
          <td>(</td>
          <td class="paramtype">TraceCounterHandle_t&#160;</td>
          <td class="paramname"><em>xCounterHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace counter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCounterHandle</td><td>Initialized trace counter handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2e9567e1b12afeea68e415f46963c5ca" name="ga2e9567e1b12afeea68e415f46963c5ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e9567e1b12afeea68e415f46963c5ca">&#9670;&#160;</a></span>xTraceCounterSetCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceCounterSetCallback </td>
          <td>(</td>
          <td class="paramtype">TraceCounterCallback_t&#160;</td>
          <td class="paramname"><em>xCallback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace counter callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xCallback</td><td>Callback</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
